Skip to content

docs: OpenRouter response caching guide + rendered architecture diagram#144

Merged
KylinMountain merged 2 commits into
mainfrom
docs/openrouter-response-caching
Jun 26, 2026
Merged

docs: OpenRouter response caching guide + rendered architecture diagram#144
KylinMountain merged 2 commits into
mainfrom
docs/openrouter-response-caching

Conversation

@KylinMountain

Copy link
Copy Markdown
Collaborator

Two docs updates shipped together.

1. OpenRouter response caching — examples/configuration/README.md

Documents how to opt into OpenRouter's Response Caching via extra_headers for openrouter/* models — identical-payload requests return in ~80–300ms with zero token billing (helps the compile-retry path and repeated lint/dev iteration). Reuses the existing extra_headers passthrough (top-level or under litellm:); no code changes.

2. Rendered architecture diagram — README.md, assets/

Replaces the ASCII architecture diagram under How OpenKB Works → Architecture with a rendered illustration (assets/openkb-architecture.png) covering the same pipeline: raw/ intake → markitdown (short docs) / PageIndex (long PDFs) → LLM wiki compilation → the wiki/ foundation (index.md, log.md, AGENTS.md, sources/, summaries/, concepts/, entities/, explorations/, reports/) → query/chat, the Skill Factory, and future generators.

  • Image lives in a new top-level assets/ dir — docs/ is gitignored, so README assets can't live there.
  • ~1.7MB; can compress to WebP / lower-res (~200–400KB) if preferred.

OpenRouter Response Caching (sending X-OpenRouter-Cache / -TTL headers on
compiler LLM calls) is achievable through the general extra_headers
passthrough — no dedicated config needed. Document it in the configuration
guide alongside the other litellm/extra_headers recipes.

Refs #39
Swap the text-based diagram under "Architecture" for a rendered
illustration (assets/openkb-architecture.png) covering the same pipeline:
raw/ intake -> markitdown (short docs) / PageIndex (long PDFs) -> LLM
wiki compilation -> the wiki/ foundation -> query/chat, the Skill
Factory, and future generators.
@KylinMountain KylinMountain merged commit fd1756f into main Jun 26, 2026
1 check passed
@KylinMountain KylinMountain deleted the docs/openrouter-response-caching branch June 26, 2026 23:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant